#region The MIT License
// The MIT License
// 
// Copyright (c) 2009 octalforty studios
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#endregion
using System;
using System.Collections.Generic;
using octalforty.Componento.Shared.SemanticModel;

namespace octalforty.Componento.ComponentModel.Installation
{
    /// <summary>
    /// Represents a resource installer, which can install various resources
    /// to a well-defined location.
    /// </summary>
    public interface IResourceInstallerService
    {
        /// <summary>
        /// Occurs before resource <see cref="ResourceInstallingEventArgs.ResourceUri"/> is installed.
        /// </summary>
        event ResourceInstallingEventHandler InstallingResource;

        /// <summary>
        /// Installs <paramref name="resources"/> to <paramref name="targetPath"/>.
        /// </summary>
        /// <param name="resources"></param>
        /// <param name="targetPath"></param>
        /// <param name="pathMapping"></param>
        void InstallResources(IEnumerable<Uri> resources, string targetPath, PathMapping pathMapping);

        /// <summary>
        /// Returns a reference to <see cref="IResourceInstaller"/> which is capable of installing
        /// resource identified by <paramref name="resourceUri"/> or <c>null</c>
        /// if no Resource Installer for a given URI is registered.
        /// </summary>
        /// <param name="resourceUri"></param>
        /// <returns></returns>
        IResourceInstaller ResolveResourceInstaller(Uri resourceUri);
    }
}
